Basic Formatting
Margin is a plain-text format for notes. Each line is interpreted by its prefix, so a note stays readable in a text editor while rendering as a structured document in MellowMill.
Start with a title
The first line in a note the note title, and is required for the note. Each note needs to have a unique title, if you try and create a note with a duplicate title you will be notified of the conflict.
Approach
Working with notes is designed to be a keyboard-first approach, so that you can be as effecient as possible.
You can press a backslash (\) character at the start of a line to display a visual selection of line types. This allows you to set the line type without remembering the syntax.
However, using the Margin syntax makes the editing experience as fast and effecient as possible. We would recommend learning some of the syntax where possible.
Headings
Headings are created by using the > character at the start of the line. Up to three are supported to give three level of headings within the note.
Use `>` for a first-level heading, `>>` for a second-level heading, and `>>>` for a third-level heading. Leave the prefix followed by a space.
> Heading 1
>> Heading 2
>>> Heading 3
tasks
Tasks are added in a note as a line of text.
Not Started Tasks
These are denoted by using a hypen at the start of a line:
- A pending task
This renders as:
In Progress Tasks
These are denoted by using a forward slash character:
/ A task in progress
becomes:
Completed Tasks
These are denoted by using a pipe character:
| A completed task
becomes:
Unordered lists
In order to create an unordered list we start the line of each list item with a *
* List item 1
* List item 2
This renderes as
You can created indented list items by pressing the tab key while a list item is selected. Shift + tab lets you un-indent list items.
Ordered lists
Ordered lists lead with an increasing number as the list icon. These are defined by starting the line for each list item with a plus character.
+ List item 1
+ List item 2
This renders as:
You can created indented list items by pressing the tab key while a list item is selected. Shift + tab lets you un-indent list items.
Tags
Tags are used to categorize notes and the tasks that they contain. Think of a tag like a folder, except that as a note can have multiple tags a note can be in multiple ‘folders’ at the same time.
Place tags on their own line starting with a hash character.
#tag
For more information see Tags
Hyperlinks
Hyperlinks allow you to link to external resources and web pages. To do this simply add a link to a line. Lines that start with https:// are automatically rendered as a link or they can be rendered in the middle of a line of text.
You can edit a link to alter the display text and whether it displays as a button or as a link.
Linking to another note
Linking to other notes in your workspace is as simple as typing [[
This lets you select any existing note which then displays a clickable link. Alternatively you can create a new note by typing in a new note name.
Summary
The basic formatting that can be used in MellowMill can be summarized as:
| Prefix | Meaning | Examle |
|---|---|---|
| > | Header 1 | > Introduction |
| >> | Header 2 | >> Summary |
| >>> | Header 3 | >>> Details |
| - | Backlog task | - Pick-up milk |
| / | In progress task | / Produce report |
| | | Completed task | | Review contract |
| * | Unordered list item | * List item |
| + | Numbered list item | + List item 1 |
| # | Tag | # Project - Reduce Costs |
| https:// | External linl | https://mellowmill.app |
#Basic Functionality